Add CLI examples for Amazon Managed Grafana workspace operations #9787
Conversation
- Add create-workspace example showing basic and advanced workspace creation - Add describe-workspace example for retrieving workspace details - Add update-workspace example for modifying workspace configuration - Improves documentation coverage for Amazon Managed Grafana service
elysahall
added
documentation
|
Hi @elysahall , Could you please review the PR? |
There was a problem hiding this comment.
Hi @sushilk123, I only have a few requested changes. After you update your examples, commit and push to this PR. Then we should be good for maintainer review.
| @@ -0,0 +1,55 @@ | |||
| **To create a Grafana workspace** | |||
There was a problem hiding this comment.
| **To create a Grafana workspace** | |
| **Example 1: To create a Grafana workspace** |
| } | ||
| } | ||
|
|
||
| **To create a workspace with custom data sources** |
There was a problem hiding this comment.
| **To create a workspace with custom data sources** | |
| **Example 2: To create a workspace with custom data sources** |
| "grafanaVersion": "9.4" | ||
| } | ||
| } | ||
|
|
There was a problem hiding this comment.
Please provide a "For more information" link for every example in this request. See format in the contribution guide: https://aws.github.io/aws-cli/docs_styleguide.html#for-more-information-link
| "dataSources": ["CLOUDWATCH", "PROMETHEUS", "XRAY"], | ||
| "notificationDestinations": ["SNS"] | ||
| } | ||
| } |
There was a problem hiding this comment.
Please provide a "For more information" link for every example in this request. See format in the contribution guide: https://aws.github.io/aws-cli/docs_styleguide.html#for-more-information-link
| "stackSetName": "grafana-workspace-stack", | ||
| "workspaceRoleArn": "arn:aws:iam::123456789012:role/service-role/AmazonGrafanaServiceRole-g1234567890" | ||
| } | ||
| } |
There was a problem hiding this comment.
Please provide a "For more information" link for every example in this request. See format in the contribution guide: https://aws.github.io/aws-cli/docs_styleguide.html#for-more-information-link
| "modified": "2023-05-07T21:30:45.789000+00:00" | ||
| } | ||
| } | ||
|
|
There was a problem hiding this comment.
Please provide a "For more information" link for every example in this request. See format in the contribution guide: https://aws.github.io/aws-cli/docs_styleguide.html#for-more-information-link
| "notificationDestinations": ["SNS", "SES"], | ||
| "modified": "2023-05-07T21:35:12.456000+00:00" | ||
| } | ||
| } |
There was a problem hiding this comment.
Please provide a "For more information" link for every example in this request. See format in the contribution guide: https://aws.github.io/aws-cli/docs_styleguide.html#for-more-information-link
| @@ -0,0 +1,43 @@ | |||
| **To update a Grafana workspace** | |||
There was a problem hiding this comment.
| **To update a Grafana workspace** | |
| **Example 1: To update a Grafana workspace** |
| } | ||
| } | ||
|
|
||
| **To update workspace data sources** |
There was a problem hiding this comment.
| **To update workspace data sources** | |
| **Example 2: To update workspace data sources** |
2 participants
Description
Adds missing CLI examples for Amazon Managed Grafana service commands to improve documentation coverage.
Changes
Testing
Examples follow existing AWS CLI documentation format and provide realistic use cases for essential Grafana workspace management including creation, inspection, and configuration updates.